home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / gfx / conv / dumpdtanim012.lha / dumpdtanim / dumpdtanim.guide (.txt) < prev    next >
Amigaguide Document  |  1996-12-12  |  11KB  |  188 lines
  1. **  $VER: dumpdtanim.guide 1.2 (11.12.96)
  2. **  dumpdtanim 1.2
  3. **  documentation
  4. **  (C) Copyright 1996 by Roland 'Gizzy' Mainz
  5. **          All Rights Reserved
  6. ===================== dumpdtanim  documentation  ==========================
  7. ===========================================================================
  8. DataTypes application example. Creates single pictures and sounds from
  9. an "animation.datatype" subclass object and/or writes the selected
  10. animation part as an IFF FILM stream. Based on the CBM datatypes example
  11. source/ documents written by David Junod.
  12. =============================== Misc ======================================
  13. ===========================================================================
  14. I write this tool to split animations (for those animations which have a
  15. matching "animation.datatype" (e.g. "anim.datatype", "cdxl.datatype",
  16. "mpegvideo.datatype", "mpegsystem.datatype", "picmovie.datatype",
  17. "anim.datatype", "film.datatype", "moviesetter.datatype" etc.) into their
  18. single components, pictures and sounds and/or write the selected part
  19. as an IFF FILM stream to file or clipboard.
  20. Thanks to Alexander G.M. Smith, who invented the IFF FILM format and send
  21. me detailed information about it.
  22. See AminetCD2:gfx/show/AGMSFilm2.lha, which includes tools for playing,
  23. cutting etc. IFF FILMs and more documents.
  24. The "film.datatype" (not included, see aminet:util/dtype/) is able to play
  25. back IFF FILM streams either from disk or from clipboard.
  26. This tool shows also the usage of datatypes object when saving data
  27. to IFF files (using the DTA_SourceType attribute with DTST_RAM).
  28. Now I fully support SAS/C for all my projects (SMakefile included).
  29. A matching DMakefile is on the way.
  30. ====================== Request for comments/help ==========================
  31. ===========================================================================
  32. 1. Who owns the rights on the "animation.datatype" (source-)code
  33. 2. dito. "amigaguide.(datatype|library)"
  34. 3. email address (or something equal) of David N. Junod
  35. For my address, email etc. see below...
  36. Wanted: Test files:
  37. These files __MUST__ be packed into a LhA archive (for compression and
  38. for checksumming. I won't like to search for "phantom" errors caused
  39. by corrupt files.)
  40. 1. Valid IFF LIST FILM files (ILBM's with interleaved 8SVX's)
  41.    (for "film.datatype" testing).
  42. 2. CDXL files except "CALLNOW.XL" and "Walk.cdxl".
  43. 3. Small mpeg system streams (mpeg video + audio) (<= 2MB)
  44. Thanks !!
  45. =============================== Usage =====================================
  46. ===========================================================================
  47. This tool is (currently) a shell only tool which takes the following
  48. arguments:
  49. template:
  50. NAME/A,MOVIE/S,STARTFRAME/K/N,STOPFRAME/K/N,SKIPFRAMES/K/N,IFFFILM=FILM/K,
  51. CLIPIFFFILM=CLIPFILM/S,CLIPIFFFILMUNIT=CLIPFILMUNIT/K/N,PICTUREPERFRAME/S,
  52. SAMPLEPERFRAME=SPF/S,GLOBALSAMPLE/S
  53. NAME               -- file name to process. Must be an animation (or
  54.                         a movie (anim with sound), if you set the MOVIE
  55.                         switch). An existing and active datatypes subclass
  56.                         must exists, because this tool uses these
  57.                         "animation.datatype" subclasses to load the
  58.                         animation.
  59. MOVIE              -- set if you want to process movies (e.g. animations
  60.                         with sound)
  61. STARTFRAME         -- start of animation sequence to process
  62.                       Defaults to 1.
  63. STOPTFRAME         -- stop of animation sequence to process
  64.                       Defaults to the maximum number of frames in the animation.
  65. SKIPFRAMES         -- skip this amount of frames during scan.
  66.                       Default to 1.
  67. IFFFILM            -- Write out an IFF FILM stream to file.
  68. CLIPIFFFILM        -- Write out an IFF FILM stream to clipboard
  69. CLIPIFFFILMUNIT    -- Clipboard number to use when writing an IFF FILM stream
  70.                       to clipboard.
  71.                       Defaults to 0.
  72. PICTUREPERFRAME    -- for each frame of the animation, create a picture
  73.                         (it will be called
  74.                         "<animfile name>_picture_<ts>.ilbm" where
  75.                         <anim file name> is the filename part of the
  76.                         animation set by the NAME option and <ts> the time
  77.                         stamp of the frame.)
  78. SAMPLEPERFRAME
  79. SPF                -- (for movies:) create single sample files from
  80.                         samples found in the frame.
  81.                         (it will be called
  82.                         "<animfile name>_sample_<ts>.8svx" where
  83.                         <anim file name> is the filename part of the
  84.                         animation set by the NAME option and <ts> the time
  85.                         stamp of the frame.)
  86. GLOBALSAMPLE       -- create global sample from all samples collected.
  87.                         (the output file will be called
  88.                         "<anim file name>_sample_global.8svx" where
  89.                         <anim file name> is the filename part of the
  90.                         animation set by the NAME option.
  91. The tool creates then a row of pictures/samples and may be aborted using
  92. CTRL-C.
  93. ================================ BUGS =====================================
  94. ===========================================================================
  95. | Warning: I've much trouble with the "picture.datatype" replacement
  96. | picture.datatype V43 (tested with 43.714,43.748,43.753). This tool
  97. | won't work properly with it. This is not a bug of "dumpdtanim",
  98. | the problem is caused by the new "picture.datatype".
  99. - Be carefull when using CBM's "anim.datatype" (e.g. IFF ANIM-5 subclass).
  100.   It's very buggy and may crash your system.
  101.   This is not a bug of "dumpdtanim" nor "animation.datatype".
  102. BUG REPORTS should contain your machine (type, CPU, FPU etc.), additional
  103. hardware (graphics card and the emulation software) and your used software
  104. (KICK/WB3.0/3.1, cybergfx etc.)
  105. ============================== History ====================================
  106. ===========================================================================
  107.     First public release
  108.     - Corrected the sound period calculations. The value is now
  109.       got from the system instead using a constant which was only on a
  110.       PAL-System correct.
  111.     - Implemented IFF FILM output format.
  112.     - Implemented STARTFRAME, STOPFRAME, SKIPFRAMES options to read-out
  113.       small parts of the animation.
  114.     - Minor code cleanup.
  115.     - The tool now returns correct error codes for most errors.
  116. =============================== TODO ======================================
  117. ===========================================================================
  118.   - WB support, adding my standart tool startup
  119.   - add SPM output
  120.     (SPM -- single picture movie -- is the input description "How to build"
  121.     a movie or animation from single frames and sounds for my
  122.     "picmovie.datatype" (e.g. it does the work of "dumpdtanim" backwards)).
  123.   - code cleanup
  124.   - Fix some inconsistensies
  125.   - autodoc
  126.   - DMakefile
  127.   - More time to rework this and other public projects
  128. =========================== Future ========================================
  129. ===========================================================================
  130. I decided to contact the current owners of the "animation.datatype" code
  131. (AmigaTech., VisCorp etc.) because I want to do the official future
  132. development of "animation.datatype" (and "picture.datatype", if possible).
  133. If there are any comments/ideas, bug reports etc., send them to me.
  134. I'm going to write an article to explain how a subclass of
  135. "animation.datatype", the common pitfalls etc. Don't try this without my
  136. article. This text will also explain future improvements.
  137. ============================ Requirements =================================
  138. ===========================================================================
  139. - You need at least Kick/WB 3.0.
  140. | Many people wrote me that they cannot find an "animation.datatype" class.
  141. | Only the 3.1 release contains it. (Subclasses of) animation.datatype
  142. | can run under 3.0.
  143. - "datatypes/animation.datatype", >= V39.
  144.   "animation.datatype 40.7 (28.09.93)" requires itself some libraries/boopsi
  145.   classes:
  146.   - "realtime.library", >= V39              - for timing
  147.   - "gadgets/tapedeck.gadget" (any version) - for the controls
  148. - You need "picture.datatype" < V43. The "extended" picture.datatype V43
  149.   caused a lot of touble (only if you use the PICTUREPERFRAME option,
  150.   otherwise this tool should work nice).
  151. - If you want to dump out movies (e.g. animations with sound), you need
  152.   the "sound.datatype" class in your environment.
  153. =========================== Author's Request ==============================
  154. ===========================================================================
  155. By  releasing  this program I do  not  place any obligations on you,
  156. feel free to share this program with your  friends (and enemies).
  157. If you want to blame me, report any bugs, or wants a new version
  158. send your letter to:
  159.                 Roland Mainz
  160.                 Hohenstaufenstra
  161.                 52388 N
  162. rvenich
  163.                 GERMANY
  164. Phone: (+49)(0)2426/4111
  165. EMAIL is also available:
  166. GISBURN@w-specht.rhein-ruhr.de
  167. If you want to send me attachments larger than 1MB (up to 5MB, more with my
  168. permission):
  169. Up to Januar 1997 I'm reachable using this email address, too:
  170. Reinhold.A.Mainz@KBV.DE
  171. | Please put your name and address in your mails !
  172. | German mailers should add their phone numbers.
  173. | See BUGS section above when submitting bug reports.
  174. Sorry, but I can only look once a week for mails.
  175. If you don't hear something from me within three weeks, please send your
  176. mail again (but watch about new releases) (problems with this email port
  177. are caused by reconfigurations, hackers, network problems etc.).
  178. The  entire  "dumpdtanim"  package  may  be  noncommercially
  179. redistributed, provided  that  the package  is always  distributed in it's
  180. complete  form (including it's documentation).  A small copy fee  for media
  181. costs is okay but any kind of commercial distribution is strictly forbidden!
  182. Comments  and  suggestions  how  to  improve  this  program  are generally
  183. appreciated!
  184. Thanks to David Junod, who wrote the animation.datatype and lots of the
  185. datatypes example code, Alexander G. M. Smith for his IFF FILM format
  186. and the documents about it, Matt Dillon for his DICE, Olaf 'Olsen' Barthel
  187. for his help, ideas and some text clips from his documentations.
  188.